home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / ifl_c / iflFileDesc.z / iflFileDesc
Encoding:
Text File  |  2002-10-03  |  7.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc - IFL's image file descriptor
  10.  
  11.  
  12. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  13.      This is a base class with no inheritance.
  14.  
  15.  
  16. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  17.      #include <ifl/ilCdefs.h>
  18.  
  19.  
  20. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      iflFileDesc is IFL's image file descriptor.  It is created from a file
  22.      name and/or a Unix file descriptor.  It can either parse apart the
  23.      components of a IFL file name (Unix file name, image index, format name,
  24.      format specific string) or be supplied with a pre-parsed name.
  25.  
  26.      An iflFileDesc can be used to pre-parse an IFL file name, perhaps to
  27.      check if the Unix file already exists when saving to a file, and then
  28.      passed to iiiiffffllllFFFFiiiilllleeee::::::::ooooppppeeeennnn() or iiiiffffllllFFFFiiiilllleeee::::::::ccccrrrreeeeaaaatttteeee() to avoid reparsing the
  29.      name.  It can also be used to implement a different file name syntax by
  30.      passing the pre-parsed file name to the alternate constructors.
  31.  
  32. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  33.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  34.  
  35.           iflFileDesc* iflFileDescCreate(const char* name, iflFormat* format)
  36.           iflFileDesc* iflFileDescPreParsed(const char* fileName,
  37.                                             int index, const char* formatName,
  38.                                             const char* formatSpecific)
  39.           iflFileDesc* iflFileDescFullyParsed(const char* fileName,
  40.                                               int index, iflFormat* format,
  41.                                               const char* formatSpecific)
  42.  
  43.      GGGGeeeetttt aaaannnndddd sssseeeetttt mmmmeeeetttthhhhooooddddssss
  44.  
  45.           void iflFileDescSetFileDesc(iflFileDesc *obj, int filedesc)
  46.           iflStatus iflFileDescGetStatus(iflFileDesc *obj)
  47.           const char* iflFileDescGetFileName(iflFileDesc *obj)
  48.           int iflFileDescGetFileDesc(iflFileDesc *obj)
  49.           int iflFileDescGetIndex(iflFileDesc *obj)
  50.           const char* iflFileDescGetFormatName(iflFileDesc *obj)
  51.           iflFormat* iflFileDescGetFormat(iflFileDesc *obj)
  52.           const char* iflFileDescGetFormatSpecific(iflFileDesc *obj)
  53.  
  54.  
  55.  
  56. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  57.      iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc(((())))
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))
  71.  
  72.  
  73.  
  74.           iflFileDesc* iflFileDescPreParsed(const char* fileName,
  75.                                             int index, const char* formatName,
  76.                                             const char* formatSpecific)
  77.           iflFileDesc* iflFileDescFullyParsed(const char* fileName,
  78.                                               int index, iflFormat* format,
  79.                                               const char* formatSpecific)
  80.           iflFileDesc* iflFileDescCreate(const char* name, iflFormat* format)
  81.  
  82.  
  83.           The first contructor creates a descriptor by parsing a IFL file name
  84.           into it's components: Unix file name, image index, format name and
  85.           format specifc string.  The second contructor creates a descriptor
  86.           from an already parsed name, The third version is the same as the
  87.           second except it takes the format by pointer instead of by name.
  88.  
  89.      ggggeeeettttFFFFiiiilllleeeeDDDDeeeesssscccc(((())))
  90.  
  91.           int iflFileDescGetFileDesc(iflFileDesc *obj)
  92.  
  93.  
  94.           This method returns the Unix file descriptor.
  95.  
  96.      ggggeeeettttFFFFiiiilllleeeeNNNNaaaammmmeeee(((())))
  97.  
  98.           const char* iflFileDescGetFileName(iflFileDesc *obj)
  99.  
  100.  
  101.           This method returns the Unix file name portion of the parsed name.
  102.  
  103.      ggggeeeettttFFFFoooorrrrmmmmaaaatttt(((())))
  104.  
  105.           iflFormat* iflFileDescGetFormat(iflFileDesc *obj)
  106.  
  107.  
  108.           This method returns the iflFormat* for the format name portion of
  109.           the parsed name.
  110.  
  111.      ggggeeeettttFFFFoooorrrrmmmmaaaattttNNNNaaaammmmeeee(((())))
  112.  
  113.           const char* iflFileDescGetFormatName(iflFileDesc *obj)
  114.  
  115.  
  116.           This method returns the format name portion of the parsed name.
  117.  
  118.      ggggeeeettttFFFFoooorrrrmmmmaaaattttSSSSppppeeeecccciiiiffffiiiicccc(((())))
  119.  
  120.           const char* iflFileDescGetFormatSpecific(iflFileDesc *obj)
  121.  
  122.  
  123.           This method returns the format specifc portion of the parsed name.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllFFFFiiiilllleeeeDDDDeeeesssscccc((((3333))))
  137.  
  138.  
  139.  
  140.      ggggeeeettttIIIInnnnddddeeeexxxx(((())))
  141.  
  142.           int iflFileDescGetIndex(iflFileDesc *obj)
  143.  
  144.  
  145.           This method returns the sub-image index portion of the parsed name.
  146.  
  147.      ggggeeeettttSSSSttttaaaattttuuuussss(((())))
  148.  
  149.           iflStatus iflFileDescGetStatus(iflFileDesc *obj)
  150.  
  151.  
  152.           This method returns the status of parsing the file name (e.g. if an
  153.           unknown format name was encoutered).
  154.  
  155.      sssseeeettttFFFFiiiilllleeeeDDDDeeeesssscccc(((())))
  156.  
  157.           void iflFileDescSetFileDesc(iflFileDesc *obj, int filedesc)
  158.  
  159.  
  160.           This method can be used to let IFL know that the file is already
  161.           opened and to used this file descriptor rather than re-opening it.
  162.  
  163. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  164.      iflFile(3), iflFormat(3)
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.